✨ Add community health files and governance templates#151
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds/updates GitHub community health and governance documentation under .github/ to standardize contribution, issue reporting, PR submission, and security reporting processes for the repository.
Changes:
- Expanded
.github/security.mdwith clearer vulnerability reporting instructions and contributor security requirements. - Added a PR template and GitHub issue templates/config to structure incoming contributions.
- Updated contributing guidance and introduced a Code of Conduct document.
Show a summary per file
| File | Description |
|---|---|
.github/security.md |
Expands security policy and adds contributor/dependency security guidance. |
.github/pull_request_template.md |
Adds a PR template with sections and contributor checklist. |
.github/issue_template/bug_report.md |
Adds a bug report issue template. |
.github/issue_template/feature_request.md |
Adds a feature request issue template. |
.github/issue_template/config.yml |
Adds issue template configuration (disables blank issues, adds contact link). |
.github/contributing.md |
Updates contribution workflow and links to templates/CoC; adds signing/labels guidance. |
.github/code_of_conduct.md |
Adds a Contributor Covenant-based Code of Conduct. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (2)
.github/contributing.md:31
- The links to the issue templates use hyphenated filenames (
bug-report.md,feature-request.md), but the actual template files arebug_report.mdandfeature_request.md. Update these links to match the real paths so contributors don’t hit 404s.
Before creating bug reports, please check the existing issues to avoid duplicates. Use the [Bug Report template](./issue_template/bug-report.md) when creating a bug report. When you create a bug report, include as many details as possible:
- A clear and descriptive title
- Steps to reproduce the behavior
- Expected behavior versus actual behavior
- Screenshots or terminal output (if applicable)
- Environment details (OS, Node.js version, etc.)
- Command line arguments you used with the tool
See [About issue and pull request templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) for more information.
### Suggesting Enhancements
Enhancement suggestions are tracked as GitHub issues. Use the [Feature Request template](./issue_template/feature-request.md) when creating an enhancement suggestion:
.github/contributing.md:88
- There appears to be a stray sentence fragment starting with a leading comma on this line, and the README update guidance is duplicated across two consecutive lines. Please remove the fragment and keep a single, clear instruction so the Pull Request section reads cleanly.
, please use the [Pull Request template](./pull_request_template.md). Pull requests that affect functionality must include updates to the relevant documentation in the README.md file
When submitting pull requests that affect functionality, please make sure to update the relevant documentation in the README.md file as well.
- Files reviewed: 7/7 changed files
- Comments generated: 3
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Stefan Stölzle <stoe@github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request establishes a comprehensive set of GitHub community health files and governance documentation to improve project maintainability, contribution experience, and security posture. These templates provide structure for contributors and maintainers to follow consistent processes.
Type of Change
Changes Made
code_of_conduct.mdto establish community standards and expected behaviorbug_report.mdandfeature_request.mdwith issue configpull_request_template.mdwith comprehensive checks and metadata guidancecontributing.mdwith clearer contribution guidelines and standardssecurity.mdwith security policy and reporting proceduresTesting
No functional code changes; community files verified for formatting and completeness.
Checklist
Additional Context
These templates support best practices for open source governance and help streamline contributions.